iT邦幫忙

2024 iThome 鐵人賽

DAY 12
0
生成式 AI

API: Swagger, Postman系列 第 12

在 Postman 中處理 API 響應:解析 JSON。

  • 分享至 

  • xImage
  •  

1. 什麼是 JSON 解析?

當我們發送 API 請求後,伺服器通常會返回 JSON 格式的資料,這些資料就是 API 的回應。解析 JSON 就是從回應裡提取我們需要的數據,比如用戶資料或狀態碼。這有助於我們驗證 API 是否正確工作。

2. 如何解析 JSON 響應?

在 Postman 中,我們可以簡單地檢視和解析 JSON 響應:

  1. 發送 API 請求

    • 發送一個請求,收到的回應通常是 JSON 格式。例如:
      {
      "userId": 1,
      "id": 101,
      "title": "This is a post",
      "body": "Post body content"
      }
  2. 檢視 JSON 響應

    • Postman 會在回應區顯示 JSON,你可以用「Pretty」模式來更容易地閱讀它。
  3. 撰寫測試腳本來解析 JSON

    • 我們可以用 JavaScript 在 Postman 的「Tests」標籤頁寫一些簡單的腳本來解析回應,檢查裡面的數據。例如,檢查 userId 是否為 1:
      var jsonData = pm.response.json();
      pm.test("User ID is 1", function () {
          pm.expect(jsonData.userId).to.eql(1);
      });
      
  4. 提取數據

    • 如果我們想從回應中提取一些數據來用於後續請求,可以這樣做:
      pm.environment.set("postId", jsonData.id);
      
    • 這樣,我們就把 id 存成了一個變數,方便下次使用。

3. 範例腳本

假設你收到這樣的 JSON 響應:

{
"id": 123,
"username": "user123",
"email": "user123@example.com"
}

你可以這樣解析並驗證數據:

var jsonData = pm.response.json();
pm.test("Check username", function () {
    pm.expect(jsonData.username).to.eql("user123");
});
pm.environment.set("userId", jsonData.id);

這個腳本會檢查 username 是否正確,並將 id 保存下來。


上一篇
使用 Postman 測試 API:設置環境變量。
系列文
API: Swagger, Postman12
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言